#include <viewport.h>
Inheritance diagram for mudbox::ViewPort:
Public Types |
|
enum | RedrawType { eFull, eArea, eOverlayOnly } |
This type controls the behaviour of the
Redraw function, used as a parameter there. More... |
|
Public Member Functions |
|
virtual const mudbox::ClassDesc * | RuntimeClass (void) const |
virtual unsigned int | FilterCount (void) const |
Returns the number of ViewPortFilters
associated with this ViewPort. |
|
virtual ViewPortFilter * | Filter (unsigned int iIndex) const |
Returns a pointer to a ViewPortFilter
associated with this ViewPort. |
|
virtual void | AddFilter (ViewPortFilter *pFilter) |
Associates a ViewPortFilter with
this ViewPort. |
|
virtual void | RemoveFilter (unsigned int iIndex) |
Removes a ViewPortFilter that was
associated with this ViewPort. The filter is not
deleted. |
|
void | LockFilterCalibration (bool bLocked) |
Locks/unlocks the calibration of all
viewport filters associated with this ViewPort. (See ViewPortFilter::LockCalibration()).
|
|
virtual void | SaveScreenshot (const QString &sFileName) const |
Saves a snapshot of the current viewport to
the given image file name. |
|
virtual int | Width (void) |
Returns the width of the ViewPort in pixels. |
|
virtual int | Height (void) |
Returns the height of the ViewPort in pixels.
|
|
virtual float | CursorXPosition (void) const |
Returns the current cursor horizontal
position inside the viewport in the 0-1 range. |
|
virtual float | CursorYPosition (void) const |
Returns the current cursor vertical position
inside the viewport in the 0-1 range. |
|
const SurfacePoint * | CursorSurfacePoint (void) const |
Returns the surface point which is under the
cursor. |
|
unsigned int | LayerCount (void) const |
This is the same as FilterCount(). |
|
Layer * | Layer (unsigned int iLayerIndex) const |
This is the same as Filter(). |
|
void | UnlinkLayer (class Layer *pLayer) |
This is the same as RemoveFilter(). |
|
Layer * | CreateLayer (void) |
Returns a new ViewPortFilter.
|
|
void | AddLayer (class Layer *pLayer) |
This is the same as AddFilter(). |
|
Layer * | ActiveLayer (void) const |
Returns a pointer to the active layer
(filter). That is, the one last clicked on by the user. |
|
void | SetActiveLayer (class Layer *pLayer) |
Set a layer (filter) to be the active one.
|
|
ViewPortFilter::RequirementValue | ViewPortFilterRequirements (void) const |
Returns the combined requirements of all
visible ViewPortFilters associated with this ViewPort. |
|
void | Redraw (RedrawType eType=eFull, float fXStart=0, float fYStart=0, float fXEnd=0, float fYEnd=0) |
Calling this function will redraw the
viewport. |
|
virtual struct ViewPortState | ViewPortState (void) |
Returns the viewport state structure.
|
|
Static Public Member Functions |
|
const mudbox::ClassDesc * | StaticClass (void) |
mudbox::Node * | CreateInstances (unsigned int iCount=1) |
|
This type controls the behaviour of the Redraw function, used as a parameter there.
00228 { 00229 eFull, 00230 eArea, 00231 eOverlayOnly 00232 }; |
|
Reimplemented from mudbox::LayerContainer. 00145 : |
|
Reimplemented from mudbox::LayerContainer. |
|
Reimplemented from mudbox::LayerContainer. |
|
Returns the number of ViewPortFilters associated with this ViewPort. |
|
Returns a pointer to a ViewPortFilter associated with this ViewPort.
|
|
Associates a ViewPortFilter with this ViewPort.
|
|
Removes a ViewPortFilter that was associated with this ViewPort. The filter is not deleted.
|
|
Locks/unlocks the calibration of all viewport filters associated with this ViewPort. (See ViewPortFilter::LockCalibration()).
|
|
Saves a snapshot of the current viewport to the given image file name. The file type will be determined by the extension of the file name (eg .png, .bmp, .tif). See also Kernel()->RenderScene() for a more flexible method.
|
|
Returns the width of the ViewPort in pixels. |
|
Returns the height of the ViewPort in pixels. |
|
Returns the current cursor horizontal position inside the viewport in the 0-1 range. |
|
Returns the current cursor vertical position inside the viewport in the 0-1 range. |
|
Returns the surface point which is under the cursor. |
|
This is the same as FilterCount(). Reimplemented from mudbox::LayerContainer. |
|
This is the same as Filter().
Reimplemented from mudbox::LayerContainer. |
|
This is the same as RemoveFilter().
Reimplemented from mudbox::LayerContainer. |
|
Returns a new ViewPortFilter. Reimplemented from mudbox::LayerContainer. |
|
This is the same as AddFilter().
Reimplemented from mudbox::LayerContainer. |
|
Returns a pointer to the active layer (filter). That is, the one last clicked on by the user. Reimplemented from mudbox::LayerContainer. |
|
Set a layer (filter) to be the active one.
Reimplemented from mudbox::LayerContainer. |
|
Returns the combined requirements of all visible ViewPortFilters associated with this ViewPort. |
|
Calling this function will redraw the viewport.
|
|
Returns the viewport state structure. |